Interface SnmpAgent

All Superinterfaces:
IPCObject, Process
All Known Implementing Classes:
SnmpAgentImpl

public interface SnmpAgent extends Process
Information provided by the PKI file:

    \class SnmpAgent
    
    \brief SnmpAgent holds and manipulates the SNMP agent.
    
    \example network().getDevice("Router0").getProcess("SnmpAgent")
    
Author:
Auto-generated
  • Method Details

    • getCommunity

      Pair<String,Access> getCommunity(String community)
      Information provided by the PKI file:
      
          \brief Returns the community with the specified name.
          
          \param community, the name of the community of interest.
          
          \return pair<string, Access, the community name and access privileges.
          Access privileges:  eAccess_ReadOnly = 0,
          eAccess_ReadWrite = 1,
          eAccess_ReadCreate = 2,
          eAccess_NotAccessible = 3
          
              
      Parameters:
      community - Takes in a parameter of community
      Returns:
      Pair<String, Access> Returns a Pair<String, Access>
    • getCommunityAt

      Pair<String,Access> getCommunityAt(int index)
      Information provided by the PKI file:
      
          \brief Returns the community at the specified name.
          
          \param index, the index of the community of interest.
          
          \return pair<string, Access, the community name and access privileges.
          Access privileges:  eAccess_ReadOnly = 0,
          eAccess_ReadWrite = 1,
          eAccess_ReadCreate = 2,
          eAccess_NotAccessible = 3
          
              
      Parameters:
      index - Takes in a parameter of index
      Returns:
      Pair<String, Access> Returns a Pair<String, Access>
    • removeCommunity

      boolean removeCommunity(String communityStr)
      Information provided by the PKI file:
      
          \brief Removes the specified community.
          
          \param communityStr, the name of the community of interest.
          
          \return bool, true if successful, otherwise false.
          
              
      Parameters:
      communityStr - Takes in a parameter of communityStr
      Returns:
      boolean Returns a boolean
    • addCommunity

      void addCommunity(String communityStr, Access access)
      Information provided by the PKI file:
      
          \brief Adds a community.
          
          \param communityStr, the name of the community.
          \param access,      the community name and access privileges.
          Access privileges:  eAccess_ReadOnly = 0,
          eAccess_ReadWrite = 1,
          eAccess_ReadCreate = 2,
          eAccess_NotAccessible = 3
          
          \return bool, true if successful, otherwise false.
          
              
      Parameters:
      communityStr - Takes in a parameter of communityStr
      access - Takes in a parameter of access
    • getCommunityCount

      int getCommunityCount()
      Information provided by the PKI file:
      
          \brief Returns the number of communities.
          
          \return int, the number of communities.
          
              
      Returns:
      int Returns a int
    • isEnabled

      boolean isEnabled()
      Information provided by the PKI file:
      
          \brief Returns true if the SNMP agent is enabled, otherwise false.
          
          \return bool, true if the SNMP agent is enabled, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • setEnabled

      void setEnabled(boolean enabled)
      Information provided by the PKI file:
      
          \brief Enables or disables the SNMP agent.
          
          \return enabled, true to enable the SNMP agent, false to disable it.
          
              
      Parameters:
      enabled - Takes in a parameter of enabled